home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / u_man / cat1 / dmedia / vlcmd.z / vlcmd
Encoding:
Text File  |  2002-10-03  |  9.3 KB  |  199 lines
  1.  
  2.  
  3.  
  4. vvvvllllccccmmmmdddd((((1111))))                                                              vvvvllllccccmmmmdddd((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      vlcmd - Video Library command line interface
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      vvvvllllccccmmmmdddd [[[[----hhhh]]]]
  13.  
  14. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  15.      -_h   Print help message (command and arguments list).
  16.  
  17.  
  18. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  19.      The application vvvvllllccccmmmmdddd provides a command line interface to the
  20.      functionality of the Video Library.  Operations such as creating paths
  21.      and setting/getting controls can be accomplished on the command line, or
  22.      from a script.
  23.  
  24.      For ease of access to nodes and paths vvvvllllccccmmmmdddd maintains 2 arrays. Once
  25.      created, all nodes and paths are referred to by their array indices.
  26.      These are represented in the command argument lists by nodeindex and
  27.      pathindex. Nodeid and pathid are the ID numbers assigned by the Video
  28.      Library when each is created.
  29.  
  30.  
  31. CCCCOOOOMMMMMMMMAAAANNNNDDDDSSSS
  32.      ooooppppeeeennnnvvvviiiiddddeeeeoooo
  33.           The ooooppppeeeennnnvvvviiiiddddeeeeoooo command connects to the video server. This should be
  34.           the first command of any vlcmd script.
  35.  
  36.      sssseeeettttppppaaaatttthhhhiiiidddd <_p_a_t_h_i_n_d_e_x> <_p_a_t_h_i_d>
  37.           The sssseeeettttppppaaaatttthhhhiiiidddd command associates a path with an index into the path
  38.           array. You can then use the index to refer to the path in other
  39.           vvvvllllccccmmmmdddd commmands.  Use sssseeeettttppppaaaatttthhhhiiiidddd if you know the ID number of the
  40.           path you want and it has already been created in a currently running
  41.           application. You can get the ID from several of the supplied video
  42.           applications by running them with the -_I option.
  43.  
  44.      sssseeeettttnnnnooooddddeeeeiiiidddd <_n_o_d_e_i_n_d_e_x> <_n_o_d_e_i_d>
  45.           The sssseeeettttnnnnooooddddeeeeiiiidddd command associates a node with an index into the node
  46.           array. You can then use the index to refer to the node in other
  47.           vvvvllllccccmmmmdddd commmands.  Use sssseeeettttnnnnooooddddeeeeiiiidddd if you know the ID number of the
  48.           node you want and the node has previously instantiated by a
  49.           vlGetNode() call in a currently running application. You can get the
  50.           ID from several of the supplied video applications by running them
  51.           with the -_I option.
  52.  
  53.      ggggeeeettttddddeeeevvvviiiicccceeee <_p_a_t_h_i_n_d_e_x>
  54.           The ggggeeeettttddddeeeevvvviiiicccceeee command prints the number of the device on the given
  55.           path.
  56.  
  57.      ggggeeeettttddddeeeevvvviiiicccceeeelllliiiisssstttt
  58.           The ggggeeeettttddddeeeevvvviiiicccceeeelllliiiisssstttt command prints the number of the devices as well
  59.           as the name and number of each device accessible to the video
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. vvvvllllccccmmmmdddd((((1111))))                                                              vvvvllllccccmmmmdddd((((1111))))
  71.  
  72.  
  73.  
  74.           server.
  75.  
  76.      ggggeeeettttccccoooonnnnttttrrrroooolllllllliiiisssstttt <_p_a_t_h_i_n_d_e_x> <_n_o_d_e_i_n_d_e_x>
  77.           The ggggeeeettttccccoooonnnnttttrrrroooolllllllliiiisssstttt command information on all controls on the given
  78.           node on the given path. The path must be setup prior to using this
  79.           command.
  80.  
  81.      ggggeeeettttnnnnooooddddeeee <_n_o_d_e_i_n_d_e_x> <_s_o_u_r_c_e|_d_r_a_i_n|_d_e_v_i_c_e|_i_n_t_e_r_n_a_l>
  82.           <_v_i_d_e_o|_g_r_a_p_h_i_c_s|_m_e_m_o_r_y|_s_c_r_e_e_n|_t_e_x_t_u_r_e|_n_e_t_w_o_r_k|_b_l_e_n_d_e_r> <_n_o_d_e_n_u_m> The
  83.           ggggeeeettttnnnnooooddddeeee command gets a node of the given type, kind and number and
  84.           associates it with an index into the node array. You can then use
  85.           the index to refer to the node in other vvvvllllccccmmmmdddd commands. Use ggggeeeettttnnnnooooddddeeee
  86.           if you do not know the ID of the node you want or if the node(s)
  87.           have not have not been previously instantiated by a vlGetNode() call
  88.           in another currently running application.
  89.  
  90.      ccccrrrreeeeaaaatttteeeeppppaaaatttthhhh <_p_a_t_h_i_n_d_e_x> <_d_e_v_i_c_e_n_u_m> <_s_r_c_n_o_d_e_i_n_d_e_x> <_d_r_n_n_o_d_e_i_n_d_e_x>
  91.           The ccccrrrreeeeaaaatttteeeeppppaaaatttthhhh command creates a path on the given device, with the
  92.           given nodes and associates it with an index into the path array. You
  93.           can then use the index to refer to the path in other vvvvllllccccmmmmdddd commands.
  94.           Use ccccrrrreeeeaaaatttteeeeppppaaaatttthhhh if you do not know the ID of the path you want or it
  95.           has not already been created by a currently running application.
  96.  
  97.      sssseeeettttuuuuppppppppaaaatttthhhhssss <_p_a_t_h_i_n_d_e_x> <_s_h_a_r_e|_r_e_a_d_o_n_l_y|_l_o_c_k|_d_o_n_e_u_s_i_n_g>
  98.           <_s_h_a_r_e|_r_e_a_d_o_n_l_y|_l_o_c_k|_d_o_n_e_u_s_i_n_g> The sssseeeettttuuuuppppppppaaaatttthhhhssss command sets up the
  99.           given (previously created) path with the given control and stream
  100.           usages, respectively.
  101.  
  102.      aaaaddddddddnnnnooooddddeeee <_p_a_t_h_i_n_d_e_x> <_n_o_d_e_i_n_d_e_x>
  103.           The aaaaddddddddnnnnooooddddeeee command adds the given node to the given path. The path
  104.           must be setup prior to using this command.
  105.  
  106.      rrrreeeemmmmoooovvvveeeennnnooooddddeeee <_p_a_t_h_i_n_d_e_x> <_n_o_d_e_i_n_d_e_x>
  107.           The rrrreeeemmmmoooovvvveeeennnnooooddddeeee command removes the given node from the given path.
  108.           The path must be setup prior to using this command.
  109.  
  110.      sssseeeettttccccoooonnnnttttrrrroooollll <_c_o_n_t_r_o_l_t_y_p_e> <_p_a_t_h_i_n_d_e_x> <_n_o_d_e_i_n_d_e_x> <_d_a_t_a_1> <_d_a_t_a_2>
  111.           The sssseeeettttccccoooonnnnttttrrrroooollll command sets a control of type _c_o_n_t_r_o_l_t_y_p_e on the
  112.           given node and path to values _d_a_t_a_1 _a_n_d _d_a_t_a_2 _d_a_t_a_1 is the
  113.           numerator, _d_a_t_a_2 is the denominator. Where the control value is an
  114.           x,y pair _d_a_t_a_1 is x, _d_a_t_a_2 is y. Where it is an int or boolean _d_a_t_a_1
  115.           is the control value, _d_a_t_a_2 can be any integer but must not be left
  116.           blank.
  117.  
  118.      ggggeeeettttccccoooonnnnttttrrrroooollll <_c_o_n_t_r_o_l_t_y_p_e> <_p_a_t_h_i_n_d_e_x> <_n_o_d_e_i_n_d_e_x>
  119.           The ggggeeeettttccccoooonnnnttttrrrroooollll command gets the values of a control of type
  120.           _c_o_n_t_r_o_l_t_y_p_e on the given node and path and prints out the values
  121.           returned in the VVVVLLLLCCCCoooonnnnttttrrrroooollllVVVVaaaalllluuuueeee struct.
  122.  
  123.      cccclllloooosssseeeevvvviiiiddddeeeeoooo
  124.           The cccclllloooosssseeeevvvviiiiddddeeeeoooo command disconnects from the video server.
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. vvvvllllccccmmmmdddd((((1111))))                                                              vvvvllllccccmmmmdddd((((1111))))
  137.  
  138.  
  139.  
  140.      hhhheeeellllpppp  The hhhheeeellllpppp command prints the command and arguments list.
  141.  
  142.  
  143.      qqqq||||qqqquuuuiiiitttt||||eeeexxxxiiiitttt
  144.           The qqqq,qqqquuuuiiiitttt or eeeexxxxiiiitttt command exits vvvvllllccccmmmmdddd....
  145.  
  146.  
  147. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  148.      vlinfo(1), vidtomem(1), memtovid(1), videoin(1), videoout(1)
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.